<?xml version='1.0' encoding='iso-8859-1'?>
<!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
	<head>
		<title>
			ModuleRead.c
			</title>
		<meta http-equiv='content-type' content='text/html;iso-8859-1'/>
		<meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
		<meta name='author' content='cmaier@cmassoc.net'/>
		<meta name='robots' content='noindex,nofollow'/>
		<link href='toolkit.css' rel='stylesheet' type='text/css'/>
		</head>
	<body>
		<div class='headerlink'>
			[<a href='ModuleDump.c.html' title=' ModuleDump.c '>PREV</a>]
			[<a href='toolkit.html' title=' Index '>HOME</a>]
			[<a href='ModuleSession.c.html' title=' ModuleSession.c '>NEXT</a>]
			</div>
<pre>
/*====================================================================*
 *
 *   Copyright (c) 2013 Qualcomm Atheros, Inc.
 *
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or 
 *   without modification, are permitted (subject to the limitations 
 *   in the disclaimer below) provided that the following conditions 
 *   are met:
 *
 *   * Redistributions of source code must retain the above copyright 
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above 
 *     copyright notice, this list of conditions and the following 
 *     disclaimer in the documentation and/or other materials 
 *     provided with the distribution.
 *
 *   * Neither the name of Qualcomm Atheros nor the names of 
 *     its contributors may be used to endorse or promote products 
 *     derived from this software without specific prior written 
 *     permission.
 *
 *   NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE 
 *   GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE 
 *   COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR 
 *   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 *   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 *   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 
 *   OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 *   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 *   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 *   OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 *   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  
 *
 *--------------------------------------------------------------------*/

/*====================================================================*
 *
 *   signed ModuleRead (struct plc * plc, struct _file_ * file, uint16_t source, uint16_t module, uint16_t submodule);
 *
 *   plc.h
 *
 *   Read a module from volatile or non-volatile memory and write it
 *   to file;
 *
 *
 *   Contributor(s):
 *      Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
 *
 *--------------------------------------------------------------------*/

#ifndef MODULEREAD_SOURCE
#define MODULEREAD_SOURCE

#include &lt;stdint.h&gt;
#include &lt;unistd.h&gt;
#include &lt;memory.h&gt;

#include &quot;../tools/error.h&quot;
#include &quot;../tools/files.h&quot;
#include &quot;../tools/endian.h&quot;
#include &quot;../tools/memory.h&quot;
#include &quot;../plc/plc.h&quot;

signed ModuleRead (struct plc * plc, struct _file_ * file, uint16_t source, uint16_t module, uint16_t submodule)

{
	struct channel * channel = (struct channel *)(plc-&gt;channel);
	struct message * message = (struct message *)(plc-&gt;message);

#ifndef __GNUC__
#pragma pack (push,1)
#endif

	struct __packed vs_module_operation_read_request
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint32_t RESERVED;
		uint8_t NUM_OP_DATA;
		struct __packed
		{
			uint16_t MOD_OP;
			uint16_t MOD_OP_DATA_LEN;
			uint32_t MOD_OP_RSVD;
			uint16_t MODULE_ID;
			uint16_t MODULE_SUB_ID;
			uint16_t MODULE_LENGTH;
			uint32_t MODULE_OFFSET;
		}
		MODULE_SPEC;
	}
	* request = (struct vs_module_operation_read_request *)(message);
	struct __packed vs_module_operation_read_confirm
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint16_t MSTATUS;
		uint16_t ERR_REC_CODE;
		uint32_t RESERVED;
		uint8_t NUM_OP_DATA;
		struct __packed
		{
			uint16_t MOD_OP;
			uint16_t MOD_OP_DATA_LEN;
			uint32_t MOD_OP_RSVD;
			uint16_t MODULE_ID;
			uint16_t MODULE_SUB_ID;
			uint16_t MODULE_LENGTH;
			uint32_t MODULE_OFFSET;
		}
		MODULE_SPEC;
		uint8_t MODULE_DATA [PLC_MODULE_SIZE];
	}
	* confirm = (struct vs_module_operation_read_confirm *)(message);

#ifndef __GNUC__
#pragma pack (pop)
#endif

	unsigned timer = channel-&gt;timeout;
	uint16_t length = PLC_MODULE_SIZE;
	uint32_t offset = 0;
	Request (plc, &quot;Read Module from %s&quot;, source? &quot;Flash&quot;: &quot;Memory&quot;);
	if (lseek (file-&gt;file, 0, SEEK_SET) == -1)
	{
		error (PLC_EXIT (plc), errno, FILE_CANTHOME, file-&gt;name);
		return (-1);
	}
	while (length == PLC_MODULE_SIZE)
	{
		memset (message, 0, sizeof (* message));
		EthernetHeader (&amp;request-&gt;ethernet, channel-&gt;peer, channel-&gt;host, channel-&gt;type);
		QualcommHeader (&amp;request-&gt;qualcomm, 0, (VS_MODULE_OPERATION | MMTYPE_REQ));
		plc-&gt;packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
		request-&gt;NUM_OP_DATA = 1;
		request-&gt;MODULE_SPEC.MOD_OP = HTOLE16 (source);
		request-&gt;MODULE_SPEC.MOD_OP_DATA_LEN = HTOLE16 (sizeof (request-&gt;MODULE_SPEC));
		request-&gt;MODULE_SPEC.MOD_OP_RSVD = HTOLE32 (0);
		request-&gt;MODULE_SPEC.MODULE_ID = HTOLE16 (module);
		request-&gt;MODULE_SPEC.MODULE_SUB_ID = HTOLE16 (submodule);
		request-&gt;MODULE_SPEC.MODULE_LENGTH = HTOLE16 (length);
		request-&gt;MODULE_SPEC.MODULE_OFFSET = HTOLE32 (offset);

#if 0
#if defined (__GNUC__)
#warning &quot;Debug code active in module ModuleRead&quot;
#endif

		fprintf (stderr, &quot;----- \n&quot;);
		fprintf (stderr, &quot;RESERVED 0x%08X\n&quot;, LE32TOH (request-&gt;RESERVED));
		fprintf (stderr, &quot;NUM_OP_DATA %d\n&quot;, request-&gt;NUM_OP_DATA);
		fprintf (stderr, &quot;MOD_OP 0x%02X\n&quot;, LE16TOH (request-&gt;MODULE_SPEC.MOD_OP));
		fprintf (stderr, &quot;MOD_OP_DATA_LEN %d\n&quot;, LE16TOH (request-&gt;MODULE_SPEC.MOD_OP_DATA_LEN));
		fprintf (stderr, &quot;RESERVED 0x%08X\n&quot;, LE32TOH (request-&gt;MODULE_SPEC.MOD_OP_RSVD));
		fprintf (stderr, &quot;MODULE_ID 0x%04X\n&quot;, LE16TOH (request-&gt;MODULE_SPEC.MODULE_ID));
		fprintf (stderr, &quot;MODULE_SUB_ID 0x%04X\n&quot;, LE16TOH (request-&gt;MODULE_SPEC.MODULE_SUB_ID));
		fprintf (stderr, &quot;MODULE_LENGTH %d\n&quot;, LE16TOH (request-&gt;MODULE_SPEC.MODULE_LENGTH));
		fprintf (stderr, &quot;MODULE_OFFSET 0x%08X\n&quot;, LE32TOH (request-&gt;MODULE_SPEC.MODULE_OFFSET));
		fprintf (stderr, &quot;\n&quot;);

#endif

		if (SendMME (plc) &lt;= 0)
		{
			error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
			return (-1);
		}
		channel-&gt;timeout = PLC_MODULE_READ_TIMEOUT;
		if (ReadMME (plc, 0, (VS_MODULE_OPERATION | MMTYPE_CNF)) &lt;= 0)
		{
			error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
			return (-1);
		}
		channel-&gt;timeout = timer;

#if 0
#if defined (__GNUC__)
#warning &quot;Debug code active in module ModuleRead&quot;
#endif

		fprintf (stderr, &quot;MSTATUS 0x%04X\n&quot;, LE16TOH (confirm-&gt;MSTATUS));
		fprintf (stderr, &quot;ERROR_REC_CODE %d\n&quot;, LE16TOH (confirm-&gt;ERR_REC_CODE));
		fprintf (stderr, &quot;RESERVED 0x%08X\n&quot;, LE32TOH (confirm-&gt;RESERVED));
		fprintf (stderr, &quot;NUM_OP_DATA %d\n&quot;, confirm-&gt;NUM_OP_DATA);
		fprintf (stderr, &quot;MOD_OP 0x%02X\n&quot;, LE16TOH (confirm-&gt;MODULE_SPEC.MOD_OP));
		fprintf (stderr, &quot;MOD_OP_DATA_LEN %d\n&quot;, LE16TOH (confirm-&gt;MODULE_SPEC.MOD_OP_DATA_LEN));
		fprintf (stderr, &quot;RESERVED 0x%08X\n&quot;, LE32TOH (confirm-&gt;MODULE_SPEC.MOD_OP_RSVD));
		fprintf (stderr, &quot;MODULE_ID 0x%04X\n&quot;, LE16TOH (confirm-&gt;MODULE_SPEC.MODULE_ID));
		fprintf (stderr, &quot;MODULE_SUB_ID 0x%04X\n&quot;, LE16TOH (confirm-&gt;MODULE_SPEC.MODULE_SUB_ID));
		fprintf (stderr, &quot;MODULE_LENGTH %d\n&quot;, LE16TOH (confirm-&gt;MODULE_SPEC.MODULE_LENGTH));
		fprintf (stderr, &quot;MODULE_OFFSET 0x%08X\n&quot;, LE32TOH (confirm-&gt;MODULE_SPEC.MODULE_OFFSET));
		fprintf (stderr, &quot;\n&quot;);

#endif

		if (LE16TOH (confirm-&gt;MSTATUS))
		{
			Failure (plc, PLC_WONTDOIT);
			return (-1);
		}
		length = LE16TOH (confirm-&gt;MODULE_SPEC.MODULE_LENGTH);
		offset = LE32TOH (confirm-&gt;MODULE_SPEC.MODULE_OFFSET);
		if (write (file-&gt;file, confirm-&gt;MODULE_DATA, length) != (signed)(length))
		{
			error (PLC_EXIT (plc), errno, FILE_CANTSAVE, file-&gt;name);
			return (-1);
		}
		offset += length;
	}
	return (0);
}

#endif


</pre>
		<div class='footerlink'>
			[<a href='ModuleDump.c.html' title=' ModuleDump.c '>PREV</a>]
			[<a href='toolkit.html' title=' Index '>HOME</a>]
			[<a href='ModuleSession.c.html' title=' ModuleSession.c '>NEXT</a>]
			</div>
		</body>
	</html>
